.\" -*- nroff -*-
.\" Copyright © 2011 inria.  All rights reserved.
.\" See COPYING in top-level directory.
.TH HWLOC-ASSEMBLER-REMOTE "1" "#HWLOC_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
hwloc-assembler-remote \- Assemble multiple remote host topologies
.
.\" **************************
.\"    Synopsis Section
.\" **************************
.SH SYNOPSIS
.B hwloc-assembler-remote
[\fIoptions\fR]
output.xml
host1 host2
\fR...
.
.\" **************************
.\"    Options Section
.\" **************************
.SH OPTIONS
.TP
\fB\-\-ssh <ssh>\fR
Use the given ssh command (and options) to connect to remote hosts.
.TP
\fB\-\-lstopo\-path <path>\fR
Use the given path as the remote lstopo command when gathering remote topologies.
By default, lstopo is taken from the PATH environment variable.
.TP
\fB\-\-lstopo\-opts <opts>\fR
Pass the given lstopo options when gathering remote topologies.
.TP
\fB\-\-show\fR
Display the resulting topology before exit.
.TP
\fB\-f \-\-force\fR
Ignore failure to load a remote host topology.
.
.\" **************************
.\"    Description Section
.\" **************************
.SH DESCRIPTION
.
hwloc-assembler-remote is a frontend to hwloc-assembler.
It takes care of retrieving the remote nodes' topologies
before assembling them with hwloc-assembler.
.
.\" **************************
.\"    Examples Section
.\" **************************
.SH EXAMPLES
.PP
To assemble three nodes topologies:

    $ hwloc-assembler-remote output.xml host1 host2 host3

.PP
To assemble the topology of a multi-process MPI job defined
as a machinefile:

    $ hwloc-assembler-remote output.xml `cat machinefile | sort | uniq`
.
.\" **************************
.\"    Return value section
.\" **************************
.SH RETURN VALUE
Upon successful execution, hwloc-assembler-remote returns 0.
.
.PP
hwloc-assembler-remote will return nonzero if any kind of error occurs, such as
(but not limited to) failure to parse the command line.
.
.\" **************************
.\"    See also section
.\" **************************
.SH SEE ALSO
.
.ft R
hwloc(7), lstopo(1), hwloc-assembler(1)
.sp
